API HTML
Esto es un ejemplo de cómo debe hacerse la petición de firma de un documento.
Debe accederse a la página https://etfirma.es/api html/ con los siguientes parámetros en la url:
- downloadurl: Dirección URL, codificada en Base64, donde se encuentra el fichero original a firmar. Debe ser una url de descarga directa.
- backurl: Dirección URL, codificada en Base64, donde se redirigirá al finalizar el proceso de firma
- name: Nombre del fichero (por ejemplo, consentimiento.pdf)
- showlogin: Opcional. Debe ser true o false. Muestra la ventana de login (permite, por ejemplo, cerrar sesión). Si no se especifica, se mostrará igualmente el diálogo de inicio de sesión si el usuario todavía no ha iniciado sesión.
- remoteSignHistory: Opcional. Debe ser true o false. Muestra el historial de firmas online.
- signatureId: Opcional. el número de firma retornado por la firma online. Muestra el historial de firmas online, pero sólo de la firma indicada.
- debug: opcional. Debe ser true. Muestra un iPad ficticio llamado "DISPOSITIVO DE DESARROLLO". Si se selecciona, se simulará el proceso de firma. Se devolverá el mismo documento que se ha enviado.
Funcionamiento
Accediendo a esta URL, se iniciará el proceso de firma. El documento que se firmará es el que se pasa en el parámetro "downloadurl".
Una vez completado el proceso de firma, la web redirigirá a la especificada en el parámetro "backurl", que tiene que ser de tu propiedad para que así puedas almacenar el documento en tu servidor. A esta url "backurl" se le añadirá los siguientes parámetros:
- signedUrl: Este parámetro contiene la URL de descarga del documento firmado. Con esta URL de descarga, puedes descargar el documento y guardarlo en tu programa para completar la integración.
- signatureId: Cuando es una firma online, nos devolverá el id de la firma empezada.
Ejemplo:
Iniciar proceso de firma (abre una nueva pestaña)
https://etfirma.es/api html/?downloadurl=aHR0cDovL2V0ZmlybWEuZXMvZG93bmxvYWRzL2xvcmVtJTIwaXBzdW0lMjBkb2xvci5wZGY=&backurl=aHR0cHM6Ly9ldGZpcm1hLmVzL2FwaSBodG1sL2RlbW8vZmluaXNoLmFzcHg=&name=lorem ipsum.pdf
Iniciar proceso de firma en modo debug (abre una nueva pestaña)
https://etfirma.es/api html/?debug=true&downloadurl=aHR0cDovL2V0ZmlybWEuZXMvZG93bmxvYWRzL2xvcmVtJTIwaXBzdW0lMjBkb2xvci5wZGY=&backurl=aHR0cHM6Ly9ldGZpcm1hLmVzL2FwaSBodG1sL2RlbW8vZmluaXNoLmFzcHg=&name=lorem ipsum.pdf
Mostrar ventana de login (abre una nueva pestaña)
https://etfirma.es/api html/?showlogin=true